Azure Maps Dataset Service (preview:2022-09-01)

2025/10/06 • 5 deleted methods

Dataset_Create (removed)
Description :  This API allows the caller to create a dataset from data that was uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/en-us/rest/api/maps/data-v2) and converted using the [Azure Maps Conversion Service](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion). You can also create a dataset directly using data uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/en-us/rest/api/maps/data-v2), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) format. For more information on how to create a dataset from a zip of GeoJSON files, please visit this [article](https://aka.ms/howtofacilitygeojson) ### Submit Create Request To create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).
Reference :  Link ¶

⚼ Request

POST:  /datasets
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
conversionId:
{
Description: ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). Only one conversionId can be provided per API call. **conversionId and udid are mutually exclusive parameters.** ,
Required: False ,
}
string ,
udid:
{
Description: ID to create the dataset. The `udid` can be obtained from uploading data using [Azure Maps Data Service](https://docs.microsoft.com/en-us/rest/api/maps/data-v2). Only one udid can be provided per API call. **outputOntology parameter must be provided with the udid. conversionId and udid are mutually exclusive parameters.** ,
Required: False ,
}
string ,
outputOntology:
{
Description: The ontology for the uploaded zip package containing GeoJSON files. **outputOntology is required if udid is provided, however, is mutually exclusive with conversionId. Currently, only the value *facility-2.0* is supported.** ,
Required: False ,
}
string ,
datasetId:
{
Description: The ID of the dataset to append with. ,
Required: False ,
}
string ,
description:
{
Description: The description to be given to the dataset. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataset_List (removed)
Description :  This API allows the caller to fetch a list of all previously successfully created datasets. ### Submit List Request To list all your datasets, issue a `GET` request with no additional parameters. ### List Data Response Here's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 2 dataset resources: ```json { "datasets": [ { "timestamp": "2020-01-01T22:50:48.123Z", "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2", "description": "Some description or comment for the dataset.", "datasetSources": { "udids": [ "15d21452-c9bb-27b6-5e79-743ca5c3205d" ], }, "ontology": "facility-2.0", "featureCounts": { "directoryInfo": 2, "category": 10, "facility": 1, "level": 3, "unit": 183, "zone": 3, "verticalPenetration": 6, "opening": 48, "areaElement": 108 } }, { "timestamp": "2020-01-01T22:57:53.123Z", "datasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", "description": "Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.", "datasetSources": { "conversionIds": [ "0c1288fa-2058-4a1b-b68d-13a5f5af7d7c" ], "udids": [ "15d21452-c9bb-27b6-5e79-743ca5c3205d" ] "appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977" }, "ontology": "facility-2.0", "featureCounts": { "directoryInfo": 2, "category": 10, "facility": 1, "level": 3, "unit": 183, "zone": 3, "verticalPenetration": 6, "opening": 48, "areaElement": 108 } } ] } ```
Reference :  Link ¶

⚼ Request

GET:  /datasets
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
datasets:
{
Description: A list of all the previously created datasets. ,
Required: False ,
}
[
{
created:
{
Description: The created timestamp for the dataset. ,
Format: date-time ,
Required: False ,
}
string ,
datasetId:
{
Description: The id for the dataset. ,
Required: False ,
}
string ,
ontology:
{
Description: The ontology version of this dataset. ,
Required: False ,
}
string ,
description:
{
Description: The description for the dataset. ,
Required: False ,
}
string ,
datasetSources:
{
Description: Information about the details of the create request for the dataset. ,
Required: False ,
}
{
conversionIds:
{
Description: The `conversionIds` used to create the dataset. ,
Required: False ,
}
[
string ,
]
,
udids:
{
Description: The `udids` used to create the dataset. ,
Required: False ,
}
[
string ,
]
,
appendDatasetId:
{
Description: The dataset that was appended to create the current dataset. ,
Required: False ,
}
string ,
}
,
featureCounts:
{
Description: The feature counts for the dataset. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataset_Get (removed)
Description :  This API allows the caller to fetch a previously successfully created dataset. ### Submit Get Details Request To get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path. ### Get Details Response Here's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource: ```json { "timestamp": "2020-01-01T22:50:48.123Z", "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2", "description": "Some description or comment for the dataset.", "datasetSources": { "conversionIds": [ "0c1288fa-2058-4a1b-b68d-13a5f5af7d7c" ], "udids": [ "15d21452-c9bb-27b6-5e79-743ca5c3205d" ] "appendDatasetId": "46d1edb6-d29e-4786-9589-dbd4efd7a977" }, "ontology": "facility-2.0", "featureCounts": { "directoryInfo": 2, "category": 10, "facility": 1, "level": 3, "unit": 183, "zone": 3, "verticalPenetration": 6, "opening": 48, "areaElement": 108 } } ```
Reference :  Link ¶

⚼ Request

GET:  /datasets/{datasetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
datasetId:
{
Description: The identifier for the dataset to query from. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
created:
{
Description: The created timestamp for the dataset. ,
Format: date-time ,
Required: False ,
}
string ,
datasetId:
{
Description: The id for the dataset. ,
Required: False ,
}
string ,
ontology:
{
Description: The ontology version of this dataset. ,
Required: False ,
}
string ,
description:
{
Description: The description for the dataset. ,
Required: False ,
}
string ,
datasetSources:
{
Description: Information about the details of the create request for the dataset. ,
Required: False ,
}
{
conversionIds:
{
Description: The `conversionIds` used to create the dataset. ,
Required: False ,
}
[
string ,
]
,
udids:
{
Description: The `udids` used to create the dataset. ,
Required: False ,
}
[
string ,
]
,
appendDatasetId:
{
Description: The dataset that was appended to create the current dataset. ,
Required: False ,
}
string ,
}
,
featureCounts:
{
Description: The feature counts for the dataset. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataset_Delete (removed)
Description :  You can use this API to delete old/unused datasets to create space for new Creator content. ### Submit Delete Request To delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.
Reference :  Link ¶

⚼ Request

DELETE:  /datasets/{datasetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
datasetId:
{
Description: The identifier for the dataset to query from. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataset_GetOperation (removed)
Description :  This API allows the caller to view the current progress of a dataset operation and the path is obtained from a call to the Create API. ### Submit Operations Request To view the current progress of a dataset operation, you will use a `GET` request where the `operationId` is the ID representing the operation. ### Operation Response While in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned.
Reference :  Link ¶

⚼ Request

GET:  /datasets/operations/{operationId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID to query the status for the dataset create/import request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
resource-location:
{
Description: If successful, a URI where details on the newly created resource can be found. ,
}
string ,
}
,
$schema:
{
Description: The response model for a Long-Running Operations API. ,
}
{
operationId:
{
Description: The Id for this long-running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status state of the request. ,
Enum:
{
NotStarted: The request has not started processing yet. ,
Running: The request has started processing. ,
Failed: The request has one or more failures. ,
Succeeded: The request has successfully completed. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
warning:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}